Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to home page in TOC and update extensions #1139

Closed
wants to merge 4 commits into from

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Nov 22, 2023

I've added the API docs home to the docs sidebar following -> https://stackoverflow.com/questions/16123951/how-do-i-include-the-homepage-in-the-sphinx-toc

Screenshot 2023-11-22 at 13 47 57

I've also added the qulacs density matrix simulation to the extensions index.

@CalMacCQ CalMacCQ changed the title Docs/minor fixes Link to home page in TOC and update extensions Nov 22, 2023
getting_started.rst
changelog.rst
install.rst
TKET website <https://tket.quantinuum.com/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we not adding extension, examples and manual to this overview?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think its more apporiate to merge the "Overview" and "More documentation" lists?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but if you have good reasons to not do that, I am happy to discuss that. But I am not sure what our general plan is how and if we want to add the general navigation bar on top?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking we add these links here as an easy near term solution and then figure out the navbar later on.

@CalMacCQ CalMacCQ closed this Nov 28, 2023
@CalMacCQ CalMacCQ deleted the docs/minor_fixes branch January 17, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants